home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Users Group Library 1996 July / C-C++ Users Group Library July 1996.iso / vol_400 / 428_02 / readme.doc < prev   
Encoding:
Text File  |  1994-03-13  |  8.7 KB  |  214 lines
  1. README.DOC
  2.  
  3. PICTOR Video Library
  4. ==============================================================
  5.    Contents:
  6. --------------------------------------------------------------
  7.  * Copyright Notice and Agreement
  8.  * Printed Manual Offer
  9.  * Additions and Corrections to the Manual
  10.  * Compilation Notes
  11.  * Help Compiler Notes (HC.EXE)
  12.  * Ed Text Editor
  13.  
  14.  
  15. ======================================================================
  16. Copyright Notice and Agreement
  17. ----------------------------------------------------------------------
  18. This product (source code, object code, supporting programs, and
  19. documentation) is protected by United States copyright law as
  20. well as international copyright treaty provisions. SoftCircuits
  21. is releasing this product to be used and distributed free of
  22. charge, providing that SoftCircuits retains its copyright, and
  23. receives credit for the work done in this product's creation.
  24.  
  25. In keeping with the above, SoftCircuits grants to you the
  26. following rights:
  27.  
  28. 1.  You may make any number of copies of the source code, object
  29. code, and supporting programs, for your own use or to be
  30. distributed to others, provided that you distribute them in the
  31. original, unmodified form, complete with all files, copyrights
  32. notices, etc, and that no fee is charged for such distribution
  33. except for reasonable media and shipping charges.
  34.  
  35. 2.  You may modify the copyrighted source code, object code, and
  36. supporting programs in connection with your use of this product.
  37. However, under copyright law, the modified source code and
  38. resulting object code remain the copyrighted property of
  39. SoftCircuits, regardless of the extent of the modifications.
  40. Therefore, you may not alter or remove any copyright notices or
  41. similar proprietary rights notices from any portion of this
  42. product.
  43.  
  44. 3.  You may also incorporate any of the copyrighted object code
  45. in executable form into your own programs, and you may use and
  46. distribute these programs royalty free, provided that all of the
  47. following requirements are satisfied:
  48.  
  49. a. All copies of such programs must bear a copyright notice, and
  50.    the form of the notice must not detract from SoftCircuits'
  51.    copyright in any way. Your own copyright notice is sufficient if
  52.    it consists entirely of the following: the word "Copyright", the
  53.    years(s) of publication of the program, and your name (or your
  54.    company name).
  55.  
  56. b. Such programs must not substantially duplicate the overall
  57.    functionality of this product or any portion thereof.
  58.  
  59. c. You must assume full and complete responsibility and
  60.    liability for the operation of these programs, including testing
  61.    of all included object code to ensure that it functions as
  62.    documented and/or as expected or required.
  63.  
  64. Except as described above, you may not legally copy or
  65. distribute the documentation, source code, object code, or
  66. supporting programs, in whole or in part. All rights not
  67. specifically granted above are reserved by SoftCircuits.
  68.  
  69. SOFTCIRCUITS SPECIFICALLY DISCLAIMS ALL WARRANTIES, INCLUDING,
  70. WITHOUT LIMITATION, ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
  71. FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT OF THIRD
  72. PARTY RIGHTS.
  73.  
  74. UNDER NO CIRCUMSTANCES WILL SOFTCIRCUITS BE LIABLE FOR SPECIAL,
  75. INCIDENTAL, CONSEQUENTIAL, INDIRECT, OR ANY OTHER DAMAGES OR
  76. CLAIMS ARISING FROM THE USE OF THIS PRODUCT, INCLUDING LOSS OF
  77. PROFITS OR ANY OTHER COMMERCIAL DAMAGES, EVEN IF WE HAVE BEEN
  78. ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. IN NO EVENT WILL
  79. SOFTCIRCUITS BE LIABLE FOR ANY CLAIMS, LIABILITY, OR DAMAGES
  80. ARISING FROM CHANGES MADE BY YOU TO THE SOURCE CODE, OBJECT
  81. CODE, OR SUPPORTING PROGRAMS.
  82.  
  83.  
  84. ======================================================================
  85. Printed Manual Offer
  86. ----------------------------------------------------------------------
  87. If you would like to obtain a printed manual for the Pictor library,
  88. complete with table of contents and index, send $9.00 + $1.50
  89. shipping (USA) to:
  90.  
  91.     SoftCircuits Programming
  92.     P.O. Box 16262
  93.     Irvine, CA 92713
  94.  
  95.  
  96. ======================================================================
  97. Additions and Corrections to the Manual
  98. ----------------------------------------------------------------------
  99. KBDREAD Utility:
  100. The KBDREAD.EXE utility displays the key code (as returned by the
  101. kbdread function) for each key pressed. It is useful for finding the
  102. keyboard code for keystrokes you want to be handled by your
  103. application. Press Escape to quit the KBDREAD program. The source code
  104. (KBDREAD.C) is also on the distribution disk(s).
  105.  
  106. There are no corrections to the manual at this time.
  107.  
  108.  
  109. ======================================================================
  110. Compilation Notes
  111. ----------------------------------------------------------------------
  112. If you are recompiling the library, the MAKEFILE file in the library-
  113. source directory is designed to be used with either Microsoft's NMAKE
  114. or Borland's MAKE. You will need to edit the make file to specify the
  115. compiler and memory model that you are using. This process is
  116. described in the make file comments. If you are using Turbo C,
  117. Quick C, or a compiler from another vender, you will probably need to
  118. make additional changes as well.
  119.  
  120. Under Microsoft C 7.0, warning level 3, the only warnings you should
  121. get relate to in-line assembler precluding optimizations in the
  122. modules that contain in-line assembler. These warnings are harmless.
  123.  
  124. Under Borland C 3.0, the only warnings are in the TONE.C module. The
  125. warning is that code has no effect. This warning is due to Borland's
  126. outp macro and not to code in the Pictor library. These warnings are
  127. also harmless.
  128.  
  129.  
  130. ======================================================================
  131. Help Compiler Notes (HC.EXE)
  132. ----------------------------------------------------------------------
  133. The help directory contains the source code to the help compiler
  134. (HC.C) and a help viewer utility (VH.C). The help compiler reads a
  135. help text file and creates a help file that can be used by the PICTOR
  136. library help functions. The compiler compresses the help text and
  137. adds additional information needed to index and access the help
  138. topics.
  139.  
  140. The help file generated by the help compiler consists of the following
  141. fields:
  142.  
  143.     [File signature]
  144.  
  145.     [Size of compressed code tree (2 bytes)]
  146.     [Compressed code tree]
  147.  
  148.     [File offset of first byte following compressed help text (4 bytes)]
  149.                                     |
  150.     [Compressed help text:]                        |
  151.        Compressed size (2 bytes)    \                |
  152.        Uncompressed size (2 bytes)   |--- For each help topic    |
  153.        Compressed help text         /                |
  154.                                     |
  155.     [Number of help topics (2 bytes)]   <---------------------------+
  156.     [Size of largest compressed help topic (2 bytes)]
  157.     [Size of largest uncompressed help topic (2 bytes)]
  158.  
  159.     [File offset of each topic's compressed help text (4 bytes each)]
  160.  
  161.     [Size of compressed topic strings (2 bytes)]
  162.     [Size of uncompressed topic strings (2 bytes)]
  163.     [Compressed topic strings--sorted alphabetically]
  164.  
  165.  
  166. ======================================================================
  167. Ed Text Editor
  168. ----------------------------------------------------------------------
  169. The distribution disk(s) includes the source code to a text editor
  170. that makes use of the PICTOR library. There is no makefile for the
  171. editor since the makefile format depends on the environment you are
  172. using. You can easily create a makefile for the editor. It should
  173. include the following modules:
  174.  
  175.     ED.C
  176.     COMMANDS.C
  177.     NAVIGATE.C
  178.     BUFFERS.C
  179.     DATA.C
  180.  
  181. Of course the editor must also be linked with the PICTOR library that
  182. corresponds to the memory model and compiler you are using. You will
  183. probably want to use the large or compact memory model since this
  184. will allow the editor more memory to load larger files.
  185.  
  186. The editor was written originally for Microsoft C. It took advantage
  187. of a Microsoft language extension that allows an array of zero
  188. elements as the last member of a structure. When the editor was made
  189. to compile under Borland C, the array was changed to contain one
  190. element. As a result, the editor currently wastes one byte per line
  191. of text. This is not significant, but if you are using Microsoft C,
  192. we recommend making the following change to the editor.
  193.  
  194. At the top of ED.H, where the _LINE structure is defined, notice that
  195. the last member of the structure appears as:
  196.  
  197.     char text[1];
  198.  
  199. You should change this to:
  200.  
  201.     char text[0];
  202.  
  203. If you are using Borland C and don't want the extra byte wasted, you
  204. will need to modify the source code. Anytime a line buffer is
  205. allocated, the number of bytes should be:
  206.  
  207.     (sizeof(LINE) - 1) + <line_length>
  208.  
  209. Where <line_length> is the number of characters on the line. Note that
  210. lines do not contain a null-terminator so the number of bytes required
  211. for an empty line would be:
  212.  
  213.     (sizeof(LINE) - 1)
  214.